<p>I am pleasure to introduce SGMLTool ; MacSgmls, SgmlForm and DicSGML.
<p>SGMLTool are the freeware. I grant to any user an royalty-free, worldwide, non-exclusive license to use, execute, reproduce, display, perform and distribute copies of SGMLTool.
<p>I do not warrant the result that issued from running SGMLTool.
<p>Please see details in the help of each SGMLTool.
<p>I wish you success in your documentation processing by SGML.
<p>The English writing is my weak point. If you will correct this document, I am very glad.
<p>Write me when you detected any error. Also write me when you adapted to new version.
<adr>KISI, KAZUTAKA
<l position=left>4608 TORIMIYAMA
<l position=left>KITAKATA, FUKUSIMA
<l position=left>966 JAPAN
<l position=left>e-mail:NAG00251@niftyserve.or.jp
</abstract>
</front>
<body>
<h1>
<h1t>Outline
<h2>
<h2t>MacSgmls
<artwork file="macsgmls">
<p>MacSgmls is a validating SGML parser, a SGML system conforming to International Standard ISO 8879 (JIS X 4151) -- Standard Generalized Markup Language.
<p>MacSgmls inputs the SGML document entity in files, parses and validates and output a simple representation of its Element Structure Information Set(ESIS). This is the information set which a structure-controlled conforming SGML application (ex. SgmlForm) should act upon. The document entity may be spread amongst several files; for example, the SGML declaration, document type definition and document instance set could each be in a separate file. You can previously specify the information about document entities as preferences of MacSgmls. If you drag and drop document entities into MacSgmls icon, then MacSgmls will read them. MacSgmls has a simple text editor.
<p>MacSgmls was derived from Sgmls-J by Kazutaka Kisi. Sgmls-J was derived from Sgmls by Satoshi Tsuchiya. Sgmls was derived from ARCSGML by James Clark. ARCSGML was written by Charles F. Goldfarb.
<h2>
<h2t>SgmlForm
<artwork file="SgmlForm">
<p>SgmlForm is a SGML formatter that related to MacSgmls, PageMaker<fnref refid="PM">, TeX<fnref refid="TeX">, etc.
<p>SgmlForm processes the ESIS-formatted data that is generated by MacSgmls. SgmlForm inputs the source-file(ESIS-formatted), and outputs the target-file(ex. the text-file for PageMaker, Tex, etc) while referring to the map-info. This is a script of MacPerl<fnref refid="Perl">.
<p>SgmlForm was written by Kazutaka Kisi.
<h2>
<h2t>DicSGML
<artwork file="dicsgml">
<p>DicSGML is a SGML Dictionary.
<p>DicSGML describes SGML terms in ISO 8879 (English) and JIS X 4151 (Japanese). By hyperlinking you can find out the term related to another term. This is a stackware of HyperCard<fnref refid="HC">.
<p>DicSGML was written by Kazutaka Kisi.
<h1>
<h1t>Installation
<artwork file="Folder">
<li>
<it>Copy the SGMLTool.sea into your appropriate folder.
<it>Doble click on SGMLTool.sea.
<it>`SGMLTool Folder' will be created automatically.
<it>SGMLTool Folder enclose the following.
<li>
<it>ReadMe ... This document(Document instance)
<it>ReadMe-J ... ReadMe for Japanese
<it>MacSgmls ver1.1.3 ... SGML Parser
<it>SgmlForm.pl ver1.4 ... SGML Formatter
<it>SgmlForm.cfg ... Configuration file for SgmlForm
<it>DicSGML ver1.5 ... SGML Dictionary
<it>SGML.DCL ... SGML declaration for Japanese
<it>HTML.DTD ... Document Type Definition `HTML'
<it>HTML.MTT ... Map-info from HTML to Text
<it>HTML.MTX ... Map-info from HTML to TeX
<it>TEXTBOOK.DTD ... Document Type Definition `TEXTBOOK'
<it>TEXTBOOK.MPM ... Map-info from TEXTBOOK to PageMaker
<it>TEXTBOOK.MTT ... Map-info from TEXTBOOK to Text
<it>TEXTBOOK.MTX ... Map-info from TEXTBOOK to TeX
<it>TEXTBOOK.MWW ... Map-info from TEXTBOOK to WWW(HTML)
<it>GraphicEPS ... Grahic data formatted EPS
<it>GraphicGIF ... Grahic data formatted GIF
<it>GraphicPIC ... Grahic data formatted PICT
</li>
</li>
<h1>
<h1t>Usages
<h2>
<h2t>Work Flow by SGMLTool
<p>The work flow on documentation by SGMLTool is as follows. [See <figref refid="Flow">]
<li>
<it>Ready the document that consists of the SGML declaration, document type definition and document instance.
<it>MacSgmls reads these document entities, and outputs ESIS-formatted data.
<it>Ready the map-info data for SgmlForm.
<it>SgmlForm reads the ESIS-formatted data, and outputs the tagged text data.
<it>Using PageMaker, TeX, etc, you can get the publication from the tagged text data.
</li>
<fig id ="Flow"><artwork file="WorkFlow"><figcap>Work Flow by SGMLTool</fig>
<h2>
<h2t>MacSgmls
<li>
<it>Launch MacSgmls.
<it>Choose About MacSgmls item from Apple menu. Read details of MacSgmls.
Click Save button, MacSgmls outputs the manual expressed by HTML.
<it>Choose Preferences item from File menu. Set an access path to document folder which have document entities. Set any other conditions for parsing the SGML document.
<it>Choose Parse item from File menu. Select a file of document entity (ex. ReadMe). You will see a new file(ex. ReadMe.esi) created by MacSgmls. Alternatively you will see a error output file.
</li>
<h2>
<h2t>SgmlForm
<li>
<it>In first time, launch SgmlForm.pl. But launching SgmlForm.pl produces a "This file is too big to be edited in MacPel. You may, however, save it as a MacPerl script or runtime." message.
<it>Save SgmlForm.pl to a droplet of SgmlForm.pl that is named SgmlForm.
<it>Quit MacPerl.
<it>Launch SgmlForm.
<it>Type command `?' then read the help message.
<it>Type command `d' if you want to know more details about SgmlForm.
Type command `o', SgmlForm outputs the manual expressed by HTML.
</li>
<h2>
<h2t>DicSgml
<li>
<it>Launch DicSgml.
<it>Click on the question mark button then read the help message.
<it>If you click any words interested, then DicSGML shows the contents related.
<it>DicSGML changes the display language if you click the heading of contents.
<it>DicSGML follows to your access path by turns if you click the return button.
</li>
<h1>
<h1t>Troubleshooting
<terms>
<dt>A message says that a program could not be found.<dd>SgmlForm needs MacPerl. DicSGML needs HyperCard. Check that these application programs exist on your hard disk.
<dt>Launching SgmlForm produces a "Can not open SgmlForm.cfg!" error message.<dd>Set SgmlForm.cfg into the same folder where SgmlForm exists. Edit SgmlForm.cfg to conform with your environment.
<dt>The online-manual of SgmlForm is not displayed in English.<dd>Edit LANGUAGE from `E' to `J' in SgmlForm.cfg.
<dt>Launching SgmlForm.pl produces a "This file is too big to be edited in MacPerl. You may, however, save it as a MacPerl script or runtime." message.<dd>Save SgmlForm.pl to a droplet of SgmlForm.pl that is named SgmlForm.
<dt>Colored buttons do not appear in DicSGML.<dd>Increase the amount of memory allocated to HyperCard using Get Info dialog box.
<dt>Launching MacSgmls produces a "Missing a access path to the document folder!" error message.<dd>Set an access path to document folder which have document entities, using Preferences item of File menu. Do not specify an alias of folder.
<dt>The document that was formed by SgmlForm is too bad layout.<dd>Check your map-info. The TEXTBOOK.MPM which is included in a package does not conform to TEXTBOOK.DTD completely. You should brush up TEXTBOOK.MPM more.
<dt>Processing TeX produces error message such as "<***.ps(***pt,***pt)> Overfull \hbox (***pt too wide) in paragraph at lines ***--***".<dd>The size of the graphic data should be adjusted on the situation. Decrease the scale factor of \epsfile command.
<dt>Processing TeX produces error message such as "epsbox: EPS File ***.ps.epsf not found".<dd>Set the graphic data into the same folder where TeX data exists.
<dt>Processing TeX produces error message such as "Overfull \hbox (***pt too wide) in paragraph at lines ***--***".<dd>The size of string in the tabular and verbatim environment should be adjusted on the situation.
<dt>While PageMaker imports a tagged text file, the tag marks appear at the page.<dd>Check the tagged radio button in the importing dialog box.
<dt>When the process of SgmlForm is aborted, the magic file such as "tempfile-**-**-**" remained in the folder.<dd>You can throw these files into the trash since these are the temporary working file.
<dt>SgmlForm was frozen after the `f' command.<dd>In SgmlForm, MacPerl can not act when reading about a long data, but it is not an active idea.
<dt>ReadMe formed by using TEXTBOOK.MPM is not displayed in English.<dd>Revise TEXTBOOK.MPM for English.
</terms>
<h1>
<h1t>Related Software
<P>I used the following software.
<fn id="PM">PageMaker 6.0J, Adobe Systems Incorporated.</fn>
<fn id="TeX">TeX 3.1415 p2.1.4, Dobald Knuth and many people.</fn>
<fn id="Perl">MacJPerl 4.18(J1.43) p36, Larry Wall and many people.</fn>
<fn id="HC">HyperCard J2-2.2.1, Apple Computer,Inc.</fn>